<HTML> 
<HEAD> 
	<TITLE>3rd Party ROBOTC Drivers</TITLE> 
<link href="tabs.css" rel="stylesheet" type="text/css"/> 
<link href="doxygen.css" rel="stylesheet" type="text/css"/> 
</HEAD> 
 
<BODY bgcolor="#ffffff" link="#000000" vlink="#000000"> 
<table width="100%" bgcolor="navy" cellspacing=0 cellpadding=1 border=0> 
<tr><td><table width="100%" bgcolor="#EEEEDD" cellspacing=0 cellpadding=3 border=0> 
<tr> 
    <td width="33%" align="left"> <img src="images/LOGO_NXT.gif" width=266 height=44 border="0" alt="Mindstorms"></td> 
    <td><b><font size="+3" color="navy">3rd Party ROBOTC Drivers</font></b></td> 
    <td align="right"> <img src="images/logo.png" width=44 height=44 border="0" alt="RobotC"></td>     
</tr> 
  <tr bgcolor="#cccc99" align="right"> 
          <td colspan=3> <font face="arial" size="-1"> [<a href=main.html>Home</a>] [<a target=_top href="https://sourceforge.net/projects/rdpartyrobotcdr/">Download</a>] [<a target=_top href="http://apps.sourceforge.net/mantisbt/rdpartyrobotcdr/my_view_page.php">Submit a bug/suggestion</a>]  [<a target=_top href="http://www.robotc.net/forums/">ROBOTC Forums</a>] [<a target=_top href="http://botbench.com">Blog</a>] [<a target=_top href="http://sourceforge.net/donate/index.php?group_id=257238">Support this project</a>]</font> </td> 
</tr> 
</table></td></tr> 
</table> 
<!-- Generated by Doxygen 1.7.2 -->
<div class="header">
  <div class="headertitle">
<h1>maxim-max127.h</h1>  </div>
</div>
<div class="contents">
<a href="maxim-max127_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*!@addtogroup other</span>
<a name="l00002"></a>00002 <span class="comment"> * @{</span>
<a name="l00003"></a>00003 <span class="comment"> * @defgroup max127 MAXIM MAX127 ADC</span>
<a name="l00004"></a>00004 <span class="comment"> * MAXIM MAX127 ADC</span>
<a name="l00005"></a>00005 <span class="comment"> * @{</span>
<a name="l00006"></a>00006 <span class="comment"> */</span>
<a name="l00007"></a>00007 
<a name="l00008"></a>00008 <span class="comment">/*</span>
<a name="l00009"></a>00009 <span class="comment"> * $Id: maxim-max127.h 133 2013-03-10 15:15:38Z xander $</span>
<a name="l00010"></a>00010 <span class="comment"> */</span>
<a name="l00011"></a>00011 
<a name="l00012"></a>00012 <span class="preprocessor">#ifndef __MAX127_H__</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define __MAX127_H__</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span><span class="comment">/** \file maxim-max127.h</span>
<a name="l00015"></a>00015 <span class="comment"> * \brief MAXIM MAX127 ADC driver</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * hitechnic-irseeker-v1.h provides an API for the MAXIM MAX127 ADC.</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * Changelog:</span>
<a name="l00020"></a>00020 <span class="comment"> * - 0.1: Initial release</span>
<a name="l00021"></a>00021 <span class="comment"> * - 0.5: Major rewrite of code, uses common.h for most functions</span>
<a name="l00022"></a>00022 <span class="comment"> *</span>
<a name="l00023"></a>00023 <span class="comment"> * License: You may use this code as you wish, provided you give credit where its due.</span>
<a name="l00024"></a>00024 <span class="comment"> *</span>
<a name="l00025"></a>00025 <span class="comment"> * THIS CODE WILL ONLY WORK WITH ROBOTC VERSION 3.59 AND HIGHER. </span>
<a name="l00026"></a>00026 <span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment"> * \author Xander Soldaat (xander_at_botbench.com)</span>
<a name="l00028"></a>00028 <span class="comment"> * \date 08 March 2009</span>
<a name="l00029"></a>00029 <span class="comment"> * \version 0.5</span>
<a name="l00030"></a>00030 <span class="comment"> * \example maxim-max127-test1.c</span>
<a name="l00031"></a>00031 <span class="comment"> */</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="preprocessor">#pragma systemFile</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef __COMMON_H__</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="common_8h.html" title="Commonly used functions used by drivers.">common.h</a>&quot;</span>
<a name="l00037"></a>00037 <span class="preprocessor">#endif //__COMMON_H__</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span>
<a name="l00039"></a><a class="code" href="group__max127.html#gabd6e0f2bf35f2423b680e85d9ea3cb71">00039</a> <span class="preprocessor">#define MAX127_I2C_ADDR 0x50     </span><span class="comment">/*!&lt; MAX127 default I2C device address */</span>
<a name="l00040"></a>00040 
<a name="l00041"></a><a class="code" href="group__max127.html#ga16c3d1450a1edd39cf33258a5b9e4806">00041</a> <a class="code" href="group__common.html#gaa172ef131853460e5b9f5c6db81d30f4">tByteArray</a> <a class="code" href="group__max127.html#ga16c3d1450a1edd39cf33258a5b9e4806">MAX127_I2CRequest</a>;    <span class="comment">/*!&lt; Array to hold I2C command data */</span>
<a name="l00042"></a><a class="code" href="group__max127.html#ga2b396b5fb8a09f1b461009d08c424af8">00042</a> <a class="code" href="group__common.html#gaa172ef131853460e5b9f5c6db81d30f4">tByteArray</a> <a class="code" href="group__max127.html#ga2b396b5fb8a09f1b461009d08c424af8">MAX127_I2CReply</a>;      <span class="comment">/*!&lt; Array to hold I2C reply data */</span>
<a name="l00043"></a>00043 
<a name="l00044"></a>00044 <span class="keywordtype">int</span> <a class="code" href="group__max127.html#gae7538917d3017d14f2195078f6f9418c">MAX127readChan</a>(tSensors link, byte i2caddress, byte adcchannel);
<a name="l00045"></a>00045 <span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment">/**</span>
<a name="l00047"></a>00047 <span class="comment"> * Returns the current analogue value as measured on the specified channel.</span>
<a name="l00048"></a>00048 <span class="comment"> * @param link the MAX127 port number</span>
<a name="l00049"></a>00049 <span class="comment"> * @param i2caddress the I2C address the MAX127 is configured for.  Use MAX127_I2C_ADDR for the default.</span>
<a name="l00050"></a>00050 <span class="comment"> * @param adcchannel the ADC channel number (0-7)</span>
<a name="l00051"></a>00051 <span class="comment"> * @return value of the ADC channel or -1 if an error occurred.</span>
<a name="l00052"></a>00052 <span class="comment"> */</span>
<a name="l00053"></a><a class="code" href="group__max127.html#gae7538917d3017d14f2195078f6f9418c">00053</a> <span class="keywordtype">int</span> <a class="code" href="group__max127.html#gae7538917d3017d14f2195078f6f9418c">MAX127readChan</a>(tSensors link, byte i2caddress, byte adcchannel) {
<a name="l00054"></a>00054   <span class="keywordtype">int</span> _chVal = 0;
<a name="l00055"></a>00055 
<a name="l00056"></a>00056   memset(<a class="code" href="group__max127.html#ga16c3d1450a1edd39cf33258a5b9e4806">MAX127_I2CRequest</a>, 0, <span class="keyword">sizeof</span>(<a class="code" href="group__common.html#gaa172ef131853460e5b9f5c6db81d30f4">tByteArray</a>));
<a name="l00057"></a>00057 
<a name="l00058"></a>00058   <a class="code" href="group__max127.html#ga16c3d1450a1edd39cf33258a5b9e4806">MAX127_I2CRequest</a>[0] = 2;                            <span class="comment">// Message size</span>
<a name="l00059"></a>00059   <a class="code" href="group__max127.html#ga16c3d1450a1edd39cf33258a5b9e4806">MAX127_I2CRequest</a>[1] = i2caddress;                   <span class="comment">// I2C Address</span>
<a name="l00060"></a>00060   <a class="code" href="group__max127.html#ga16c3d1450a1edd39cf33258a5b9e4806">MAX127_I2CRequest</a>[2] = (1 &lt;&lt; 7) + (adcchannel &lt;&lt; 4); <span class="comment">// Control Byte</span>
<a name="l00061"></a>00061   <span class="comment">// Control byte is calculated as follows:</span>
<a name="l00062"></a>00062   <span class="comment">// start bit (7) + channel number bit-shifted into place</span>
<a name="l00063"></a>00063 
<a name="l00064"></a>00064   <span class="keywordflow">if</span> (!<a class="code" href="group__common.html#gad02e06f83b264ee6fc7df41eb4712080">writeI2C</a>(link, <a class="code" href="group__max127.html#ga16c3d1450a1edd39cf33258a5b9e4806">MAX127_I2CRequest</a>, <a class="code" href="group__max127.html#ga2b396b5fb8a09f1b461009d08c424af8">MAX127_I2CReply</a>, 2))
<a name="l00065"></a>00065     <span class="keywordflow">return</span> -1;
<a name="l00066"></a>00066 
<a name="l00067"></a>00067   <span class="comment">// Convert the bytes into ints</span>
<a name="l00068"></a>00068   <span class="comment">// 1st byte contains bits 11-4 of the channel&#39;s value</span>
<a name="l00069"></a>00069   <span class="comment">// 2nd byte contains bits 3-0 of the channel&#39;s value, followed by 4 0&#39;s</span>
<a name="l00070"></a>00070   <span class="comment">// We&#39;ll need to shift the 1st byte left by 4 and the 2nd byte to the right by 4</span>
<a name="l00071"></a>00071   _chVal = ((int)(<a class="code" href="group__max127.html#ga2b396b5fb8a09f1b461009d08c424af8">MAX127_I2CReply</a>[0]) &lt;&lt; 4) + ((<span class="keywordtype">int</span>)<a class="code" href="group__max127.html#ga2b396b5fb8a09f1b461009d08c424af8">MAX127_I2CReply</a>[1] &gt;&gt; 4);
<a name="l00072"></a>00072 
<a name="l00073"></a>00073   <span class="keywordflow">return</span> _chVal;
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075 <span class="preprocessor">#endif // __MAX127_H__</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span>
<a name="l00077"></a>00077 <span class="comment">/*</span>
<a name="l00078"></a>00078 <span class="comment"> * $Id: maxim-max127.h 133 2013-03-10 15:15:38Z xander $</span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a>00080 <span class="comment">/* @} */</span>
<a name="l00081"></a>00081 <span class="comment">/* @} */</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Mar 13 2013 19:56:43 for ROBOTC Drivers by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>
